<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: DeciderUWBIREDSync Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00081.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">DeciderUWBIREDSync Class Reference<div class="ingroups"><a class="el" href="a00524.html">IEEE 802.15.4A - Classes that implement the IEEE 802.15.4A UWB PHY.</a> &#124; <a class="el" href="a00512.html">decider - decider modules</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="DeciderUWBIREDSync" --><!-- doxytag: inherits="DeciderUWBIRED" -->
<p>this <a class="el" href="a00070.html" title="The basic Decider class.">Decider</a> models a non-coherent energy-detection receiver that synchronizes on the first sync preamble sequence that is "long enough" and "powerful enough". This is defined with the respective fields tmin and syncThreshold.  
 <a href="a00081.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00469_source.html">DeciderUWBIREDSync.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for DeciderUWBIREDSync:</div>
<div class="dyncontent">
<div class="center"><img src="a00722.png" border="0" usemap="#DeciderUWBIREDSync_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for DeciderUWBIREDSync:</div>
<div class="dyncontent">
<div class="center"><img src="a00723.png" border="0" usemap="#DeciderUWBIREDSync_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00724.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34d3dda3c14aba6702cab5354c73adab"></a><!-- doxytag: member="DeciderUWBIREDSync::DeciderUWBIREDSync" ref="a34d3dda3c14aba6702cab5354c73adab" args="(DeciderToPhyInterface *phy, double sensitivity, int myIndex, bool debug)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>DeciderUWBIREDSync</b> (<a class="el" href="a00079.html">DeciderToPhyInterface</a> *<a class="el" href="a00070.html#ac0f72556cb799d883b4219cab58320bb">phy</a>, double <a class="el" href="a00020.html#a5eece8bf532f92912ccbd0a3bc4d6fb0">sensitivity</a>, int <a class="el" href="a00020.html#a33e7f02028e78116193d09d6cdbc987e">myIndex</a>, bool <a class="el" href="a00020.html#aa22cd5156240713e37578172ba5557ce">debug</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00081.html#a7b5fbb75266417f8bf5ac1d81fd86d32">initFromMap</a> (const <a class="el" href="a00070.html#a7f3ee545f2ae8b0d8d1814c98917f5b6">ParameterMap</a> &amp;params)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the decider from XML map data.  <a href="#a7b5fbb75266417f8bf5ac1d81fd86d32"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a287907b9979fe327ccba25aab845fab9"></a><!-- doxytag: member="DeciderUWBIREDSync::attemptSync" ref="a287907b9979fe327ccba25aab845fab9" args="(const airframe_ptr_t frame)" -->
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>attemptSync</b> (const <a class="el" href="a00070.html#a8532046253d31801ffe4bc56b0d70850">airframe_ptr_t</a> frame)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae93d4679bc7c6a9acd3a077f67429a90"></a><!-- doxytag: member="DeciderUWBIREDSync::evaluateEnergy" ref="ae93d4679bc7c6a9acd3a077f67429a90" args="(const airframe_ptr_t frame, const AirFrameVector &amp;syncVector) const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>evaluateEnergy</b> (const <a class="el" href="a00070.html#a8532046253d31801ffe4bc56b0d70850">airframe_ptr_t</a> frame, const <a class="el" href="a00070.html#a6baab300e0bec90320dfe956c2d15a57">AirFrameVector</a> &amp;syncVector) const </td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16413bd10803ea07f9c123b700112e05"></a><!-- doxytag: member="DeciderUWBIREDSync::tmin" ref="a16413bd10803ea07f9c123b700112e05" args="" -->
simtime_t&#160;</td><td class="memItemRight" valign="bottom"><b>tmin</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>this <a class="el" href="a00070.html" title="The basic Decider class.">Decider</a> models a non-coherent energy-detection receiver that synchronizes on the first sync preamble sequence that is "long enough" and "powerful enough". This is defined with the respective fields tmin and syncThreshold. </p>
<p>Citation of the following publication is appreciated if you use the MiXiM UWB PHY model for a publication of your own. J. Rousselot, J.-D. Decotignie, An ultra-wideband impulse radio PHY layer model for network simulation. SIMULATION January 2011 vol. 87 no. 1-2 82-112.</p>
<p>For more information, see also:</p>
<p>[1] J. Rousselot, J.-D. Decotignie, An ultra-wideband impulse radio PHY layer model for network simulation. SIMULATION January 2011 vol. 87 no. 1-2 82-112. <a href="http://dx.doi.org/10.1177/0037549710377767">http://dx.doi.org/10.1177/0037549710377767</a> [2] J. Rousselot, Ultra Low Power Communication Protocols for UWB Impulse Radio Wireless Sensor Networks. EPFL Thesis 4720, 2010. <a href="http://infoscience.epfl.ch/record/147987">http://infoscience.epfl.ch/record/147987</a> [3] A High-Precision Ultra Wideband Impulse Radio Physical Layer Model for Network Simulation, Jérôme Rousselot, Jean-Dominique Decotignie, Second International Omnet++ Workshop,Simu'TOOLS, Rome, 6 Mar 09. <a href="http://portal.acm.org/citation.cfm?id=1537714">http://portal.acm.org/citation.cfm?id=1537714</a> </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7b5fbb75266417f8bf5ac1d81fd86d32"></a><!-- doxytag: member="DeciderUWBIREDSync::initFromMap" ref="a7b5fbb75266417f8bf5ac1d81fd86d32" args="(const ParameterMap &amp;params)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool DeciderUWBIREDSync::initFromMap </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00070.html#a7f3ee545f2ae8b0d8d1814c98917f5b6">ParameterMap</a> &amp;&#160;</td>
          <td class="paramname"><em>params</em></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize the decider from XML map data. </p>
<p>This method should be defined for generic decider initialization.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">params</td><td>The parameter map which was filled by XML reader.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the initialization was successfully. </dd></dl>

<p>Reimplemented from <a class="el" href="a00080.html#a544bf3b2eecdf476feceed30bb6e4f72">DeciderUWBIRED</a>.</p>
<div class="fragment"><pre class="fragment">                                                               {
    <span class="keywordtype">bool</span>                         bInitSuccess = <span class="keyword">true</span>;
    ParameterMap::const_iterator it           = params.find(<span class="stringliteral">&quot;syncMinDuration&quot;</span>);
    <span class="keywordflow">if</span>(it != params.end()) {
        tmin = ParameterMap::mapped_type(it-&gt;second).doubleValue();
    }
    <span class="keywordflow">else</span> {
        bInitSuccess = <span class="keyword">false</span>;
        opp_warning(<span class="stringliteral">&quot;No syncMinDuration defined in config.xml for DeciderUWBIREDSync!&quot;</span>);
    }
    <span class="keywordflow">return</span> <a class="code" href="a00081.html#a7b5fbb75266417f8bf5ac1d81fd86d32" title="Initialize the decider from XML map data.">DeciderUWBIRED::initFromMap</a>(params) &amp;&amp; bInitSuccess;
}
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/modules/phy/<a class="el" href="a00469_source.html">DeciderUWBIREDSync.h</a></li>
<li>D:/Projects/MiXiM/extsrc/mixim/src/modules/phy/DeciderUWBIREDSync.cc</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00081.html">DeciderUWBIREDSync</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:32 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
